﻿/*
 * The MIT License (MIT)
 * 
 * Copyright (c) 2014 Michael Chatfield - http://xmlcomment.codeplex.com/
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and 
 * associated documentation files (the "Software"), to deal in the Software without restriction, 
 * including without limitation the rights to use, copy, modify, merge, publish, distribute, 
 * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is 
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in all copies or substantial
 * portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT 
 * NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 
 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, 
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE 
 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 * 
 */

using System.ComponentModel;
using System.Xml.Serialization;

namespace XmlCommentSerialization
{
    public abstract class XmlAnnotate
    {

        private XmlCommentElement _Comment;

        /// <summary>
        /// Internal property required to output comments with XmlSerializer
        /// </summary>
        [XmlElement(ElementName = XmlCommentElement.ElementName,
            Namespace = XmlCommentElement.Namespace)]
        [EditorBrowsable(EditorBrowsableState.Never)]
        public XmlCommentElement __Comment
        {
            get
            {
                if (_Comment == null)
                    _Comment = new XmlCommentElement(this.GetType());
                return _Comment;
            }
            set
            {
                return; // Setter is requirement for XmlSerializer
            }
        }

    }
}
